/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.hadoop.yarn.server.resourcemanager.scheduler.activities;

import org.apache.hadoop.yarn.api.records.Resource;
import org.apache.hadoop.yarn.api.resource.PlacementConstraint;
import org.apache.hadoop.yarn.util.resource.ResourceCalculator;

/**
 * Generic interface that can be used for collecting diagnostics.
 */
public interface DiagnosticsCollector {

  void collect(String diagnostics, String details);

  String getDiagnostics();

  String getDetails();

  void collectResourceDiagnostics(ResourceCalculator rc,
      Resource required, Resource available);

  void collectPlacementConstraintDiagnostics(PlacementConstraint pc,
      PlacementConstraint.TargetExpression.TargetType targetType);

  void collectPartitionDiagnostics(
      String requiredPartition, String nodePartition);
}
